<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>&quot;api&quot; | Compound.js - v0.1.2</title>
	<meta name="description" content="Documentation for Compound.js - v0.1.2">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</div>
					<ul class="results">
						<li class="state loading">Preparing search index...</li>
						<li class="state failure">The search index is not available</li>
					</ul>
					<a href="../index.html" class="title">Compound.js - v0.1.2</a>
				</div>
				<div class="table-cell" id="tsd-widgets">
					<div id="tsd-filter">
						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
						<div class="tsd-filter-group">
							<div class="tsd-select" id="tsd-filter-visibility">
								<span class="tsd-select-label">All</span>
								<ul class="tsd-select-list">
									<li data-value="public">Public</li>
									<li data-value="protected">Public/Protected</li>
									<li data-value="private" class="selected">All</li>
								</ul>
							</div>
							<input type="checkbox" id="tsd-filter-inherited" checked />
							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
							<input type="checkbox" id="tsd-filter-only-exported" />
							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
						</div>
					</div>
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
				</div>
			</div>
		</div>
	</div>
	<div class="tsd-page-title">
		<div class="container">
			<ul class="tsd-breadcrumb">
				<li>
					<a href="../globals.html">Globals</a>
				</li>
				<li>
					<a href="_api_.html">&quot;api&quot;</a>
				</li>
			</ul>
			<h1>Module &quot;api&quot;</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<section class="tsd-panel-group tsd-index-group">
				<h2>Index</h2>
				<section class="tsd-panel tsd-index-panel">
					<div class="tsd-index-content">
						<section class="tsd-index-section ">
							<h3>Functions</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-function tsd-parent-kind-module"><a href="_api_.html#account" class="tsd-kind-icon">account</a></li>
								<li class="tsd-kind-function tsd-parent-kind-module"><a href="_api_.html#ctoken" class="tsd-kind-icon">c<wbr>Token</a></li>
								<li class="tsd-kind-function tsd-parent-kind-module"><a href="_api_.html#governance" class="tsd-kind-icon">governance</a></li>
								<li class="tsd-kind-function tsd-parent-kind-module"><a href="_api_.html#markethistory" class="tsd-kind-icon">market<wbr>History</a></li>
							</ul>
						</section>
					</div>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Functions</h2>
				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
					<a name="account" class="tsd-anchor"></a>
					<h3>account</h3>
					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
						<li class="tsd-signature tsd-kind-icon">account<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/0b4de92/src/api.ts#L64">api.ts:64</a></li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Makes a request to the AccountService API. The Account API retrieves
										information for various accounts which have interacted with the protocol.
									For more details, see the Compound API documentation.</p>
								</div>
								<dl class="tsd-comment-tags">
									<dt>example</dt>
									<dd><pre><code>(<span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
  <span class="hljs-keyword">const</span> account = <span class="hljs-keyword">await</span> Compound.api.account({
    <span class="hljs-string">&quot;addresses&quot;</span>: <span class="hljs-string">&quot;0xB61C5971d9c0472befceFfbE662555B78284c307&quot;</span>,
    <span class="hljs-string">&quot;network&quot;</span>: <span class="hljs-string">&quot;ropsten&quot;</span>
  });

  <span class="hljs-keyword">let</span> daiBorrowBalance = <span class="hljs-number">0</span>;
  <span class="hljs-keyword">if</span> (<span class="hljs-built_in">Object</span>.isExtensible(account) &amp;&amp; account.accounts) {
    account.accounts.forEach(<span class="hljs-function">(<span class="hljs-params">acc</span>) =&gt;</span> {
      acc.tokens.forEach(<span class="hljs-function">(<span class="hljs-params">tok</span>) =&gt;</span> {
        <span class="hljs-keyword">if</span> (tok.symbol === Compound.cDAI) {
          daiBorrowBalance = +tok.borrow_balance_underlying.value;
        }
      });
    });
  }

  <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;daiBorrowBalance&#x27;</span>, daiBorrowBalance);
})().catch(<span class="hljs-built_in">console</span>.error);</code></pre>
									</dd>
								</dl>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>options: <span class="tsd-signature-type">object</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>A JavaScript object of API request parameters.</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4>
							<p>Returns the HTTP response body or error.</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
					<a name="ctoken" class="tsd-anchor"></a>
					<h3>c<wbr>Token</h3>
					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
						<li class="tsd-signature tsd-kind-icon">c<wbr>Token<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/0b4de92/src/api.ts#L89">api.ts:89</a></li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Makes a request to the CTokenService API. The cToken API retrieves
										information about cToken contract interaction. For more details, see the
									Compound API documentation.</p>
								</div>
								<dl class="tsd-comment-tags">
									<dt>example</dt>
									<dd><pre><code>(<span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
  <span class="hljs-keyword">const</span> cDaiData = <span class="hljs-keyword">await</span> Compound.api.cToken({
    <span class="hljs-string">&quot;addresses&quot;</span>: Compound.util.getAddress(Compound.cDAI)
  });

  <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;cDaiData&#x27;</span>, cDaiData); <span class="hljs-comment">// JavaScript Object</span>
})().catch(<span class="hljs-built_in">console</span>.error);</code></pre>
									</dd>
								</dl>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>options: <span class="tsd-signature-type">object</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>A JavaScript object of API request parameters.</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4>
							<p>Returns the HTTP response body or error.</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
					<a name="governance" class="tsd-anchor"></a>
					<h3>governance</h3>
					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
						<li class="tsd-signature tsd-kind-icon">governance<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, endpoint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/0b4de92/src/api.ts#L145">api.ts:145</a></li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Makes a request to the GovernanceService API. The Governance Service includes
										three endpoints to retrieve information about COMP accounts. For more
									details, see the Compound API documentation.</p>
								</div>
								<dl class="tsd-comment-tags">
									<dt>example</dt>
									<dd><pre><code>(<span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
  <span class="hljs-keyword">const</span> proposal = <span class="hljs-keyword">await</span> Compound.api.governance(
    { <span class="hljs-string">&quot;proposal_ids&quot;</span>: [ <span class="hljs-number">20</span> ] }, <span class="hljs-string">&#x27;proposals&#x27;</span>
  );

  <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;proposal&#x27;</span>, proposal); <span class="hljs-comment">// JavaScript Object</span>
})().catch(<span class="hljs-built_in">console</span>.error);</code></pre>
									</dd>
								</dl>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>options: <span class="tsd-signature-type">object</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>A JavaScript object of API request parameters.</p>
									</div>
								</li>
								<li>
									<h5>endpoint: <span class="tsd-signature-type">string</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>A string of the name of the corresponding governance
											service endpoint. Valid values are <code>proposals</code>, <code>voteReceipts</code>, or
										<code>accounts</code>.</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4>
							<p>Returns the HTTP response body or error.</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
					<a name="markethistory" class="tsd-anchor"></a>
					<h3>market<wbr>History</h3>
					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
						<li class="tsd-signature tsd-kind-icon">market<wbr>History<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/0b4de92/src/api.ts#L117">api.ts:117</a></li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Makes a request to the MarketHistoryService API. The market history service
										retrieves information about a market. For more details, see the Compound
									API documentation.</p>
								</div>
								<dl class="tsd-comment-tags">
									<dt>example</dt>
									<dd><pre><code>(<span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
  <span class="hljs-keyword">const</span> cUsdcMarketData = <span class="hljs-keyword">await</span> Compound.api.marketHistory({
    <span class="hljs-string">&quot;asset&quot;</span>: Compound.util.getAddress(Compound.cUSDC),
    <span class="hljs-string">&quot;min_block_timestamp&quot;</span>: <span class="hljs-number">1559339900</span>,
    <span class="hljs-string">&quot;max_block_timestamp&quot;</span>: <span class="hljs-number">1598320674</span>,
    <span class="hljs-string">&quot;num_buckets&quot;</span>: <span class="hljs-number">10</span>,
  });

  <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;cUsdcMarketData&#x27;</span>, cUsdcMarketData); <span class="hljs-comment">// JavaScript Object</span>
})().catch(<span class="hljs-built_in">console</span>.error);</code></pre>
									</dd>
								</dl>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>options: <span class="tsd-signature-type">object</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>A JavaScript object of API request parameters.</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4>
							<p>Returns the HTTP response body or error.</p>
						</li>
					</ul>
				</section>
			</section>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class="globals  ">
						<a href="../globals.html"><em>Globals</em></a>
					</li>
					<li class="current tsd-kind-module">
						<a href="_api_.html">&quot;api&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="_ctoken_.html">&quot;c<wbr>Token&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="_comp_.html">&quot;comp&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="_comptroller_.html">&quot;comptroller&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="_eth_.html">&quot;eth&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="_gov_.html">&quot;gov&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="_index_.html">&quot;index&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="_pricefeed_.html">&quot;price<wbr>Feed&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="_util_.html">&quot;util&quot;</a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
					<li class=" tsd-kind-function tsd-parent-kind-module">
						<a href="_api_.html#account" class="tsd-kind-icon">account</a>
					</li>
					<li class=" tsd-kind-function tsd-parent-kind-module">
						<a href="_api_.html#ctoken" class="tsd-kind-icon">c<wbr>Token</a>
					</li>
					<li class=" tsd-kind-function tsd-parent-kind-module">
						<a href="_api_.html#governance" class="tsd-kind-icon">governance</a>
					</li>
					<li class=" tsd-kind-function tsd-parent-kind-module">
						<a href="_api_.html#markethistory" class="tsd-kind-icon">market<wbr>History</a>
					</li>
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer>
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
			</ul>
		</div>
	</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>